<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Zend_Media_Mpeg_Object</title>
			<link rel="stylesheet" href="styles/phpdoc.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name"><img src="images/AbstractClass_logo.png"
														alt="Abstract Class"
														title="Abstract Class"
														style="vertical-align: middle"> Zend_Media_Mpeg_Object</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
							<a href="#sec-descendents">Descendents</a>
			|											<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The base class for all MPEG objects.</p>
	<ul class="tags">
				<li><span class="field">author:</span> Sven Vollbehr &lt;<a href="mailto:sven@vollbehr.eu">sven@vollbehr.eu</a>&gt;</li>
				<li><span class="field">version:</span> $Id: Object.php 177 2010-03-09 13:13:34Z svollbehr $</li>
				<li><span class="field">copyright:</span> Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)</li>
				<li><span class="field">abstract:</span> </li>
				<li><span class="field">license:</span> <a href="http://framework.zend.com/license/new-bsd">New BSD License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="Zend_Media/MPEG/_Media---Mpeg---Object.php.html">/Media/Mpeg/Object.php</a> (line <span class="field">38</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>

	<a name="sec-descendents"></a>
	<div class="info-box">
		<div class="info-box-title">Direct descendents</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
			<span class="disabled">Descendents</span>
			|												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<table cellpadding="2" cellspacing="0" class="class-table">
				<tr>
					<th class="class-table-header">Class</th>
					<th class="class-table-header">Description</th>
				</tr>
								<tr>
					<td style="padding-right: 2em; white-space: nowrap">
						<img src="images/AbstractClass.png"
								 alt="Abstract class"
								 title="Abstract class"
								 style="vertical-align: center"/>
						<a href="Zend_Media/MPEG/Zend_Media_Mpeg_Abs_Object.html">Zend_Media_Mpeg_Abs_Object</a>
					</td>
					<td>
											The base class for all MPEG Audio Bit Stream objects.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em; white-space: nowrap">
						<img src="images/Class.png"
								 alt=" class"
								 title=" class"
								 style="vertical-align: center"/>
						<a href="Zend_Media/MPEG/Zend_Media_Mpeg_Ps.html">Zend_Media_Mpeg_Ps</a>
					</td>
					<td>
											This class represents a MPEG Program Stream encoded file as described in  MPEG-1 Systems (ISO/IEC 11172-1) and MPEG-2 Systems (ISO/IEC 13818-1)  standards.
										</td>
				</tr>
							</table>
		</div>
	</div>


	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendants</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																								<div class="var-title">
					<img src="images/Variable.png" alt=" " />
					<span class="var-type">Reader</span>
					<a href="#$_reader" title="details" class="var-name">$_reader</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendants</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																																																																																								<div class="method-definition">
					<img src="images/Constructor.png" alt=" "/>
					<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"><a href="Zend_Io/Zend_Io_Reader.html">Zend_Io_Reader</a></span>&nbsp;<span class="var-name">$reader</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span>&nbsp;<span class="var-name">$options</span>)
																<span class="method-result">Zend_Media_Mpeg_Object</span>
									</div>
																<div class="method-definition">
					<img src="images/Method.png" alt=" "/>
					<a href="#clearOption" title="details" class="method-name">clearOption</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$option</span>)
																<span class="method-result">void</span>
									</div>
																<div class="method-definition">
					<img src="images/Method.png" alt=" "/>
					<a href="#formatTime" title="details" class="method-name">formatTime</a>
											(<span class="var-type">integer</span>&nbsp;<span class="var-name">$seconds</span>)
																<span class="method-result">string</span>
									</div>
																<div class="method-definition">
					<img src="images/Method.png" alt=" "/>
					<a href="#getOption" title="details" class="method-name">getOption</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$option</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$defaultValue</span> = <span class="var-default">null</span>])
																<span class="method-result">void</span>
									</div>
																<div class="method-definition">
					<img src="images/Method.png" alt=" "/>
					<a href="#getOptions" title="details" class="method-name">&amp;getOptions</a>
										()
																<span class="method-result">Array</span>
									</div>
																<div class="method-definition">
					<img src="images/Method.png" alt=" "/>
					<a href="#nextStartCode" title="details" class="method-name">nextStartCode</a>
										()
																<span class="method-result">integer</span>
									</div>
																<div class="method-definition">
					<img src="images/Method.png" alt=" "/>
					<a href="#prevStartCode" title="details" class="method-name">prevStartCode</a>
										()
																<span class="method-result">integer</span>
									</div>
																<div class="method-definition">
					<img src="images/Method.png" alt=" "/>
					<a href="#setOption" title="details" class="method-name">setOption</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$option</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
																<span class="method-result">void</span>
									</div>
																<div class="method-definition">
					<img src="images/Method.png" alt=" "/>
					<a href="#setOptions" title="details" class="method-name">setOptions</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">&$options</span>, <span class="var-type">Array</span>&nbsp;<span class="var-name">$options</span>)
																<span class="method-result">void</span>
									</div>
																<div class="method-definition">
					<img src="images/Method.png" alt=" "/>
					<a href="#__get" title="details" class="method-name">__get</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
																<span class="method-result">mixed</span>
									</div>
																<div class="method-definition">
					<img src="images/Method.png" alt=" "/>
					<a href="#__set" title="details" class="method-name">__set</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
																<span class="method-result">mixed</span>
									</div>
											</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
<a name="$_reader" id="$_reader"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<img src="images/Variable.png" />
		<span class="var-title">
			<span class="var-type">Reader</span>
			<span class="var-name">$_reader</span>
						(line <span class="line-number">45</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The reader object.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>
<a name="__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="images/Constructor.png" />
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">60</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructs the class with given parameters.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Zend_Media_Mpeg_Object</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"><a href="Zend_Io/Zend_Io_Reader.html">Zend_Io_Reader</a></span>&nbsp;<span class="var-name">$reader</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">&$options</span> = <span class="var-default">array()</span>], <span class="var-type">Array</span>&nbsp;<span class="var-name">$options</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="Zend_Io/Zend_Io_Reader.html">Zend_Io_Reader</a></span>
				<span class="var-name">$reader</span><span class="var-description">: The reader object.</span>			</li>
					<li>
				<span class="var-type">Array</span>
				<span class="var-name">$options</span><span class="var-description">: The options array.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$options</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="Zend_Media/MPEG/Zend_Media_Mpeg_Abs_Object.html#method__construct">Zend_Media_Mpeg_Abs_Object::__construct()</a>
								: Constructs the class with given parameters.
							</li>
					<li>
				<a href="Zend_Media/MPEG/Zend_Media_Mpeg_Abs.html#method__construct">Zend_Media_Mpeg_Abs::__construct()</a>
								: Constructs the Zend_Media_Mpeg_ABS class with given file and options.
							</li>
					<li>
				<a href="Zend_Media/MPEG/Zend_Media_Mpeg_Abs_Frame.html#method__construct">Zend_Media_Mpeg_Abs_Frame::__construct()</a>
								: Constructs the class with given parameters and reads object related data  from the frame.
							</li>
					<li>
				<a href="Zend_Media/MPEG/Zend_Media_Mpeg_Abs_LameHeader.html#method__construct">Zend_Media_Mpeg_Abs_LameHeader::__construct()</a>
								: Constructs the class with given parameters and reads object related data  from the bitstream.
							</li>
					<li>
				<a href="Zend_Media/MPEG/Zend_Media_Mpeg_Abs_VbriHeader.html#method__construct">Zend_Media_Mpeg_Abs_VbriHeader::__construct()</a>
								: Constructs the class with given parameters and reads object related data  from the bitstream.
							</li>
					<li>
				<a href="Zend_Media/MPEG/Zend_Media_Mpeg_Abs_XingHeader.html#method__construct">Zend_Media_Mpeg_Abs_XingHeader::__construct()</a>
								: Constructs the class with given parameters and reads object related data  from the bitstream.
							</li>
					<li>
				<a href="Zend_Media/MPEG/Zend_Media_Mpeg_Ps.html#method__construct">Zend_Media_Mpeg_Ps::__construct()</a>
								: Constructs the class with given file and options.
							</li>
				</ul>
	</div>
<a name="clearOption" id="clearOption"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="images/Method.png" />
		<span class="method-title">clearOption</span> (line <span class="line-number">117</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clears the given option value.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			clearOption
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$option</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$option</span><span class="var-description">: The name of the option.</span>			</li>
				</ul>
		
			
	</div>
<a name="formatTime" id="formatTime"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="images/Method.png" />
		<span class="method-title">formatTime</span> (line <span class="line-number">218</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Formats given time in seconds into the form of  [hours:]minutes:seconds.milliseconds.</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			formatTime
		</span>
					(<span class="var-type">integer</span>&nbsp;<span class="var-name">$seconds</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$seconds</span><span class="var-description">: The time to format, in seconds</span>			</li>
				</ul>
		
			
	</div>
<a name="getOption" id="getOption"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="images/Method.png" />
		<span class="method-title">getOption</span> (line <span class="line-number">83</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the given option value, or the default value if the option is not  defined.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			getOption
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$option</span>, [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$defaultValue</span> = <span class="var-default">null</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$option</span><span class="var-description">: The name of the option.</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$defaultValue</span><span class="var-description">: The default value to be returned.</span>			</li>
				</ul>
		
			
	</div>
<a name="getOptions" id="getOptions"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="images/Method.png" />
		<span class="method-title">getOptions</span> (line <span class="line-number">71</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the options array.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Array</span>
		<span class="method-name">
			&amp;getOptions
		</span>
				()
			</div>
	
		
			
	</div>
<a name="nextStartCode" id="nextStartCode"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="images/Method.png" />
		<span class="method-title">nextStartCode</span> (line <span class="line-number">131</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Finds and returns the next start code. Start codes are reserved bit  patterns in the video file that do not otherwise occur in the video stream.</p>
<p class="description"><p>All start codes are byte aligned and start with the following byte  sequence: 0x00 0x00 0x01.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">integer</span>
		<span class="method-name">
			nextStartCode
		</span>
				()
			</div>
	
		
			
	</div>
<a name="prevStartCode" id="prevStartCode"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="images/Method.png" />
		<span class="method-title">prevStartCode</span> (line <span class="line-number">177</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Finds and returns the previous start code. Start codes are reserved bit  patterns in the video file that do not otherwise occur in the video  stream.</p>
<p class="description"><p>All start codes are byte aligned and start with the following byte  sequence: 0x00 0x00 0x01.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">integer</span>
		<span class="method-name">
			prevStartCode
		</span>
				()
			</div>
	
		
			
	</div>
<a name="setOption" id="setOption"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="images/Method.png" />
		<span class="method-title">setOption</span> (line <span class="line-number">107</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the given option the given value.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setOption
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$option</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$option</span><span class="var-description">: The name of the option.</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$value</span><span class="var-description">: The value to set for the option.</span>			</li>
				</ul>
		
			
	</div>
<a name="setOptions" id="setOptions"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="images/Method.png" />
		<span class="method-title">setOptions</span> (line <span class="line-number">96</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the options array. See main class for available options.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setOptions
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">&$options</span>, <span class="var-type">Array</span>&nbsp;<span class="var-name">$options</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">Array</span>
				<span class="var-name">$options</span><span class="var-description">: The options array.</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">&$options</span>			</li>
				</ul>
		
			
	</div>
<a name="__get" id="__get"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<img src="images/Method.png" />
		<span class="method-title">__get</span> (line <span class="line-number">240</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Magic function so that $obj-&gt;value will work.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			__get
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: The field name.</span>			</li>
				</ul>
		
			
	</div>
<a name="__set" id="__set"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<img src="images/Method.png" />
		<span class="method-title">__set</span> (line <span class="line-number">257</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Magic function so that assignments with $obj-&gt;value will work.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			__set
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: The field name.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$value</span><span class="var-description">: The field value.</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>

	
	<p class="notes" id="credit">
		Documentation generated on Wed, 04 May 2011 08:39:38 +0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>